home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 46 / Amiga Format CD46 (1999-10-20)(Future Publishing)(GB)[!][issue 1999-12].iso / -serious- / comms / www / awebresume / awebresume.cfg < prev    next >
Text File  |  1999-09-06  |  17KB  |  358 lines
  1.     *******************************************************************
  2.     *                                                                 *
  3.     * DO NOT EDIT THIS SECTION!                                       *
  4.     *                                                                 *
  5.     * $VER: AWebResume.cfg 1.00 (26.8.99) © 1999 Duane McDonnell      *
  6.     *                                                                 *
  7.     * For technical support e-mail tachyon@tolstoi.saccii.net.au      *
  8.     *                                                                 *
  9.     *******************************************************************
  10.     *                                                                 *
  11.     * If you modify this file, be sure to save it back to             *
  12.     * "ENVARC:AWeb3/AWebResume.cfg". If AWebResume is running in the  *
  13.     * background the new configuration settings will take effect soon *
  14.     * after saving the file as AWebResume sets up a file notification *
  15.     * on the specified path. If the filesystem does not support file  *
  16.     * notifications run AWebResume again to update its configuration  *
  17.     * buffer or reboot the system.                                    *
  18.     *                                                                 *
  19.     * Some general notes on specifying configuration settings:        *
  20.     *                                                                 *
  21.     * Boolean switches (those marked BOOL) accept either 0 or 1 as    *
  22.     * their parameters. 0 means false while 1 means true.             *
  23.     *                                                                 *
  24.     * Strings (those marked STRING) can either be quoted or unquoted. *
  25.     * You should quote strings if they contain spaces. For example,   *
  26.     * "this string is quoted".                                        *
  27.     *                                                                 *
  28.     *******************************************************************
  29.  
  30.  
  31.                    ************************************
  32.                    *                                  *
  33.                    * Download resume related settings *
  34.                    *                                  *
  35.                    ************************************
  36.  
  37.  
  38. ; (BOOL). Set ResumeEnable to 1 to enable download resumes. With this
  39. ; option set AWebResume will override AWeb's normal "incomplete file"
  40. ; requesters with ones offering more options and will prevent AWeb
  41. ; from deleting interrupted downloads unless permission is given.
  42. ; AWebResume is capable of detecting all interrupted downloads even
  43. ; if AWeb doesn't normally generate requesters for them.
  44. ;
  45. ; Do not download to AWeb's temporary or cache paths if you want
  46. ; AWebResume to offer resume support for interrupted downloads. These
  47. ; paths (and their sub-directories) are ignored by AWebResume to prevent
  48. ; excessive and unnecessary interrupted download detections (unless AWeb
  49. ; would normally generate requesters for them). You should therefore set
  50. ; your "Save" path to a directory outside the scope of both the temporary
  51. ; and cache paths.
  52.  
  53. ResumeEnable    1
  54.  
  55.  
  56. ; (BOOL). Set AutoResume to 1 if you want AWebResume to automatically
  57. ; resume interrupted downloads initiated via AWeb's LOAD ARexx command
  58. ; if a download path was given. AutoResume is useful for preventing
  59. ; interrupted download requesters appearing when ARexx is controlling
  60. ; an unattended download session. This setting is ignored if a user
  61. ; requested download fails (a user request is regarded as a request
  62. ; which did not come via ARexx).
  63.  
  64. AutoResume    0
  65.  
  66.  
  67. ; (STRING). AcceptFilter and RejectFilter are used to filter files which
  68. ; you normally wouldn't download to a file and therefore wouldn't resume.
  69. ; Filtering files helps to decrease memory usage.
  70. ;
  71. ; The pattern matching filters work in two stages. Firstly, URLs which
  72. ; match AcceptFilter are added to a list of potential URLs which might
  73. ; require resuming, then this list is further pruned by applying
  74. ; RejectFilter. Note that the filters are used to filter the 'object'
  75. ; part of a URL (the final part specifying a filename). Both filters
  76. ; are case-insensitive and should be specified in standard AmigaDOS
  77. ; format. To perform no filtering at all, set AcceptFilter to "#?"
  78. ; and RejectFilter to "~(#?)".
  79. ;
  80. ; The filters are ignored if AWeb would normally generate an "incomplete
  81. ; file" requester for an interrupted download. In this case, AWebResume
  82. ; will allow the requester (or more precisely, it's override requester)
  83. ; to ensure consistency with AWeb's normal operating behaviour.
  84.  
  85. AcceptFilter    #?
  86. RejectFilter    #?.(htm|html)
  87.  
  88.  
  89. ; (STRING). Here you should specify a command template for calling a
  90. ; HTTP resumption program. The command template is similar to the normal
  91. ; arguments you would issue when invoking the program from the shell
  92. ; except you specify tokens which AWebResume expands prior to calling
  93. ; the program. You will need to refer to the HTTP resumption program's
  94. ; documentation in order to fill in this template.
  95. ;
  96. ; AWebResume supports the following basic tokens:
  97. ;
  98. ; %u    URL of file whose download was interrupted
  99. ; %f    Full file path of interrupted download file
  100. ; %p    HTTP proxy used to download initial part of file (¹)
  101. ; %r    URL which referred us to the URL being downloaded (²)
  102. ; %b    Browser user-agent/spoofing identification string
  103. ;
  104. ; Notes:
  105. ;
  106. ; ¹  It is recommended that you embed the proxy token in the conditional
  107. ;    proxy argument specifier (ResumeCondProxy) and use the %cp token
  108. ;    rather than %p in ResumeTemplate. This way, proxy information will
  109. ;    only form part of the final expanded template if a proxy was used
  110. ;    to collect the initial part of the file being resumed.
  111. ;
  112. ; ²  It is recommended that you embed the referer token in the conditional
  113. ;    referer argument specifier (ResumeCondRefer) and use the %cr token
  114. ;    rather than %r in ResumeTemplate. This way, referer information will
  115. ;    not form part of the final expanded template if you have enabled
  116. ;    AWeb's "browse anonymously" configuration option or if you manually
  117. ;    entered the URL or followed a local link to get to it (in which
  118. ;    case there is no referer).
  119. ;
  120. ; In addition to the basic tokens, AWebResume allows you to use conditional
  121. ; argument tokens in the template. Conditional argument tokens will only be
  122. ; included in the final template expansion if certain conditions are met.
  123. ;
  124. ; The following conditional argument tokens are supported:
  125. ;
  126. ; %cp   Conditional proxy argument token. If a proxy was used to download
  127. ;       the initial part of the file being resumed then this token, if
  128. ;       specified in ResumeTemplate, will be expanded to ResumeCondProxy
  129. ;       (which itself will be expanded before use). If no proxy was used
  130. ;       this token will be ignored.
  131. ;
  132. ; %cr   Conditional referer argument token. If AWeb was browsing with
  133. ;       referer information enabled then this token, if specified in
  134. ;       ResumeTemplate, will be expanded to ResumeCondRefer (which itself
  135. ;       will be expanded before use). If no referer information was in
  136. ;       use, either because you configured AWeb to browse anonymously
  137. ;       or because you entered the URL manually rather than following
  138. ;       a link to get to it, this token will be ignored.
  139. ;
  140. ; %ci    Conditional icon argument token. If AWeb was configured to
  141. ;    create icons with download files then this token, if specified
  142. ;    in ResumeTemplate, will be expanded to ResumeCondIcon.
  143. ;
  144. ; %cn    Conditional no icon argument token. If AWeb was configured to
  145. ;    not create icons with download files then this token, if specified
  146. ;    in ResumeTemplate, will be expanded to ResumeCondNoIcon.
  147.  
  148.  
  149. ;============================================================================
  150. ; The following options are for use with HTTPResume by Andriya Antonijevic.
  151. ; Note that HTTPResume's configuration file may override some of these
  152. ; settings. If you wish to use HTTPResume in conjunction with AWebResume,
  153. ; uncomment the template which best suits your requirements or write your
  154. ; own custom template and conditional specifiers. Turning on the debugging
  155. ; option is helpful if you're creating your own template or specifiers
  156. ; as the debugging output will show you the final expansion for the call
  157. ; to the HTTP resume program after all tokens have been processed. An easy
  158. ; way to invoke the resume program is to start downloading a file then
  159. ; cancel it from AWeb's network status window. AWebResume should detect
  160. ; the interrupted download and display a requester; now select 'Resume'
  161. ; and the resume program should be invoked using the supplied template.
  162. ; Note that AWebResume usually ignores download requests for files which
  163. ; are filtered out by AcceptFilter/RejectFilter, or for files which are
  164. ; within scope of AWeb's cache or temporary paths.
  165.  
  166. ; This version opens HTTPResume's GUI on AWeb's public screen or on the
  167. ; default public screen if AWeb's public screen is unavailable.
  168. ;
  169. ResumeTemplate  "HTTPResume URL="%u" OUTFILE="%f" %cp %cr %ci GUI PUBSCREEN=AWeb AUTORESUME AUTOSTART AUTOEXIT"
  170.  
  171. ; This version opens HTTPResume's GUI on the default public screen.
  172. ;
  173. ;ResumeTemplate "HTTPResume URL="%u" OUTFILE="%f" %cp %cr %ci GUI AUTORESUME AUTOSTART AUTOEXIT"
  174.  
  175. ; This version outputs to a console window on AWeb's public screen or on
  176. ; the default public screen if AWeb's public screen is unavailable.
  177. ;
  178. ;ResumeTemplate "HTTPResume URL="%u" OUTFILE="%f" %cp %cr %ci AUTORESUME > "CON:////Resuming download.../AUTO/CLOSE/WAIT/INACTIVE/SCREEN AWeb""
  179.  
  180. ; This version outputs to a console window on the default public screen.
  181. ;
  182. ;ResumeTemplate "HTTPResume URL="%u" OUTFILE="%f" %cp %cr %ci AUTORESUME > "CON:////Resuming download.../AUTO/CLOSE/WAIT/INACTIVE""
  183.  
  184.  
  185. ; (STRING). Conditional HTTP proxy argument specifier. This will be
  186. ; expanded if the %cp token is encountered in ResumeTemplate, but only
  187. ; if a proxy was used to download the initial part of the file being
  188. ; resumed. You may only use the %p token in this specifier, all other
  189. ; tokens will be ignored.
  190.  
  191. ResumeCondProxy PROXY=%p
  192.  
  193.  
  194. ; (STRING). Conditional referer argument specifier. This will be
  195. ; expanded if the %cr token is encountered in ResumeTemplate, but only
  196. ; if AWeb's "browse anonymously" configuration option is disabled and
  197. ; the URL had a referer (you followed a non-local link to get to it).
  198. ; You may only use the %r token in this specifier, all other tokens
  199. ; will be ignored.
  200.  
  201. ResumeCondRefer REFERER="%r"
  202.  
  203.  
  204. ; (STRING). Conditional icon argument specifier. This will be expanded
  205. ; if the %ci token is encountered in ResumeTemplate, but only if AWeb
  206. ; was configured to create icons for download files. No basic tokens
  207. ; are supported for this specifier, any which are encountered will be
  208. ; ignored.
  209.  
  210. ResumeCondIcon    CREATEICONS
  211.  
  212.  
  213. ; (STRING). Conditional no icon argument specifier. This will be expanded
  214. ; if the %cn token is encountered in ResumeTemplate, but only if AWeb was
  215. ; configured to not create icons for download files. No basic tokens are
  216. ; supported for this specifier, any which are encountered will be ignored.
  217.  
  218. ; Not used with HTTPResume.
  219. ;
  220. ;ResumeCondNoIcon
  221. ;============================================================================
  222.  
  223.  
  224.                *************************************
  225.                *                                   *
  226.                * Download by mail related settings *
  227.                *                                   *
  228.                *************************************
  229.  
  230.  
  231. ; (BOOL). Set MailEnable to 1 if you want AWebResume to give you the
  232. ; option of obtaining an interrupted download via your e-mail account.
  233. ; This is useful for stubborn files which AWeb and/or the resume program
  234. ; can't seem to download in full. If this option is set a 'Mail' gadget
  235. ; will appear in AWebResume's interrupted download requester. The
  236. ; download request will be sent to downloadslave.com for processing.
  237. ; This service requires that you obtain a password before submitting
  238. ; download requests. Refer to the MailPassword discussion for further
  239. ; information.
  240. ;
  241. ; ResumeEnable must also be set for this option to have any effect.
  242.  
  243. MailEnable    0
  244.  
  245.  
  246. ; (STRING). This string should be set to the password issued to you by
  247. ; downloadslave.com. The password is assigned to the address you send
  248. ; the request from so be sure to sign up with the account you want
  249. ; download requests sent to. Mail data@downloadslave.com with the
  250. ; subject set to "REQUEST PASSWORD" (no quotes) and enter the password
  251. ; you receive back below. If you lose your password send mail to the
  252. ; same address with the subject set to "REMEMBER PASSWORD".
  253.  
  254. MailPassword    your_password
  255.  
  256.  
  257. ; (STRING). Set MailAccount to the e-mail account where you want
  258. ; download requests sent to (the password specified in MailPassword must
  259. ; be assigned to this account). This address takes precedence over the
  260. ; Reply-To: address set in AWeb. If you do not specify this setting then
  261. ; AWeb's Reply-To: address from the network settings will be used.
  262.  
  263. MailAccount    user@domain.com
  264.  
  265.  
  266. ; (STRING). Here you should specify the template for calling an external
  267. ; mail program to send the download request to downloadslave.com.
  268. ;
  269. ; The template supports the following tokens:
  270. ;
  271. ; %t    To: address (this is always data@downloadslave.com)
  272. ; %r    Reply-To: address (where the file will be sent to)
  273. ; %s    Subject line with URL to download
  274. ; %m    Message body containing the required password
  275. ; %f    File containing a copy of the message body
  276. ;
  277. ; If you do not specifiy a template the mail program configured in AWeb's
  278. ; network settings will be used. AWebResume will invoke this mail program
  279. ; by asking you to submit a mailto: form. It is recommended that you
  280. ; configure MailTemplate since there is no standard way to submit a
  281. ; message body using mailto: (however, AWeb's integrated mail program
  282. ; will recognise the message body submitted by AWebResume).
  283.  
  284. ; Example template for use with YAM 2.0 by Marcel Beck (note that this
  285. ; only works if YAM is not already running, an ARexx script would be
  286. ; needed for the general case).
  287.  
  288. ;MailTemplate    "YAM MAILTO=%t SUBJECT="%s" LETTER="%f""
  289.  
  290.  
  291. ; (BOOL). When invoking the download via e-mail option using a mailto:
  292. ; form (when MailTemplate is not configured) AWebResume will create a
  293. ; temporary HTML file to load into AWeb using the "file:localhost/"
  294. ; scheme. AWeb does not disk cache local files but only memory caches
  295. ; them since it quite reasonably assumes that local files are always
  296. ; available for accessing.
  297. ;
  298. ; Setting AutoFlush tells AWebResume to generate a temporary HTML file
  299. ; when required, load it into AWeb, then delete it. While this procedure
  300. ; is desirable for keeping memory overheads to a minimum it can cause
  301. ; problems if documents are flushed from AWeb's memory cache before
  302. ; you've finished with them. In this case, AWeb won't be able to reload
  303. ; AWebResume's temporary HTML files because they will no longer exist.
  304. ;
  305. ; Clearing AutoFlush prevents AWebResume from deleting temporary HTML
  306. ; files until an AWeb shutdown is detected.
  307.  
  308. AutoFlush    0
  309.  
  310.                **************************
  311.                *                        *
  312.                * Miscellaneous settings *
  313.                *                        *
  314.                **************************
  315.  
  316.  
  317. ; (BOOL). Set ShareEnable to 1 if you want AWebResume to open AWeb's
  318. ; download files in shared read/write mode. This will allow you to read
  319. ; files while they are still being downloaded. Take care when doing this
  320. ; however as some programs will crash when given truncated files. You
  321. ; should test the program first to give yourself confidence it implements
  322. ; decent error/truncation detection. LhA is very robust in this respect,
  323. ; you can often view the contents of an archive and extract documentation
  324. ; to read before the download has completed.
  325.  
  326. ShareEnable    1
  327.  
  328.                      ******************************
  329.                      *                            *
  330.                      * Debugging related settings *
  331.                      *                            *
  332.                      ******************************
  333.  
  334.  
  335. ; (BOOL). Set DebugEnable to 1 to enable AWebResume's debugging mode.
  336. ; If you enable this option you must also specify a valid debugging
  337. ; output channel using DebugOutput. The debugging output is helpful
  338. ; if you're writing your own templates as the expanded template will
  339. ; be sent to the debugging channel when an external program is called.
  340.  
  341. DebugEnable     0
  342.  
  343.  
  344. ; (STRING). If DebugEnable was set to 1 then this option specifies the
  345. ; output channel to send the debugging information to. This should be
  346. ; given as a standard AmigaDOS file specification. If the output is to
  347. ; a file which already exists then the output will be appended to the
  348. ; existing file otherwise a new file will be created. If the output is
  349. ; to a window then the following control characters are also available
  350. ; for debugging purposes:
  351. ;
  352. ; ^C    Update settings from AWebResume's configuration file
  353. ; ^D    Update settings from AWeb's network configuration file
  354. ; ^E    Update settings from AWeb's program configuration file
  355. ; ^F    Flush URL/filename hash entries currently not in use
  356.  
  357. DebugOutput     "CON:////AWebResume Debugging Window/AUTO/CLOSE/INACTIVE"
  358.